improve: health probes showcase & docs to operations#3291
improve: health probes showcase & docs to operations#3291csviri wants to merge 35 commits intooperator-framework:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Renames the metrics-processing sample to operations and updates docs / CI references accordingly.
Changes:
- Switches the parent Maven module entry from
metrics-processingtooperations. - Updates E2E Helm values, E2E test constants, and OTEL resource attributes to use the new
operationsnaming. - Updates documentation and the E2E GitHub Actions workflow to reference
sample-operators/operations.
Reviewed changes
Copilot reviewed 9 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sample-operators/pom.xml | Updates the aggregated module list to reference operations. |
| sample-operators/metrics-processing/src/test/resources/helm-values.yaml | Renames image repository / nameOverride to operations-operator. |
| sample-operators/metrics-processing/src/test/java/.../MetricsHandlingE2E.java | Updates Helm release name to operations. |
| sample-operators/metrics-processing/src/main/java/.../MetricsHandlingSampleOperator.java | Updates OTEL resource attribute value from metrics-processing to operations. |
| sample-operators/metrics-processing/pom.xml | Renames artifact / image / display metadata to operations. |
| docs/content/en/docs/documentation/operations/metrics.md | Updates links from metrics-processing to operations. |
| docs/content/en/docs/documentation/operations/helm-chart.md | Updates narrative + example YAML + links to operations. |
| docs/content/en/blog/releases/v5-3-release.md | Updates sample operator link to operations. |
| .github/workflows/e2e-test.yml | Updates the E2E workflow to run sample-operators/operations. |
4140f1d to
c527bf1
Compare
ddde815 to
d21401e
Compare
d25a1fc to
3b935e8
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 26 out of 28 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (2)
sample-operators/operations/src/test/java/io/javaoperatorsdk/operator/sample/operations/OperationsE2E.java:394
runCommandreads stdout fully and only then reads stderr. If the process writes enough data to stderr to fill the buffer, it can block and the test will hang. PreferredirectErrorStream(true)(single reader) or drain stdout/stderr concurrently (e.g., separate threads) beforewaitFor().
sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/operations/OperationsSampleOperator.java:66- The startup log line still says "Metrics Handling Sample Operator starting!" after the module/class were renamed to operations. This makes logs confusing when running the sample; update the message to reflect the new operator name.
bab062f to
eaa0bb8
Compare
…ator/junit/ClusterDeployedOperatorExtension.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
…ator/junit/ClusterDeployedOperatorExtension.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
eef95ca to
df8bb9e
Compare
| probes: | ||
| startup: | ||
| enabled: true | ||
| path: /health |
There was a problem hiding this comment.
in this sample we are using the same endpoint, actually it we should think rather to remove startup probe, I added it here since some might need it for long running startup, but that probe can be used for both ready and startup.
So as far I can see it is correct as it is.
Signed-off-by: Attila Mészáros a_meszaros@apple.com